Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughAutomates docs versioning in the release prepare phase: adds a semantic-release plugin and an ES module script that snapshot docs for stable releases, updates docs config to use versions.json, expands release assets, and updates CI to install and cache docs dependencies. Changes
Sequence DiagramsequenceDiagram
participant SR as "semantic-release"
participant PL as "docs-versioning-plugin"
participant VD as "version-docs.mjs"
participant Bun as "Bun / Docusaurus"
participant Git as "Git (release commit)"
SR->>PL: prepare(nextRelease.version)
PL->>PL: validate semantic X.Y.Z
alt prerelease
PL-->>SR: skip docs snapshot
else stable
PL->>VD: spawn with version arg
VD->>VD: check versions.json & snapshot exists?
alt snapshot exists
VD-->>PL: skip (already versioned)
else snapshot missing
VD->>Bun: cd docs && bun run docusaurus docs:version <version>
Bun-->>VD: generate versioned_docs & sidebars
VD->>VD: ensure docs/docusaurus.config.js updated (lastVersion, versions entry)
VD-->>PL: success
end
PL-->>SR: prepare complete
end
SR->>Git: commit docs artifacts + config updates
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Deploying quickadd with
|
| Latest commit: |
e4979a2
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://4fa9bc04.quickadd.pages.dev |
| Branch Preview URL: | https://1109-automate-docs-version-s.quickadd.pages.dev |
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/docusaurus.config.js (1)
8-13: RedundantdocsVersions = []in thecatchblock.Because
docsVersionsis already initialised to[]on line 8 andrequireonly reassigns it on success, thecatchassignment is a no-op — the value never changed from the initial[].♻️ Proposed simplification
let docsVersions = []; try { docsVersions = require('./versions.json'); -} catch { - docsVersions = []; -} +} catch { /* versions.json absent (pre-first-release); keep [] */ }🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/docusaurus.config.js` around lines 8 - 13, The variable docsVersions is pre-initialized to [] and the catch block redundantly reassigns docsVersions = []; remove the redundant assignment inside the catch so the try/catch simply attempts to set docsVersions = require('./versions.json') and silently falls back to the pre-initialized value if require throws; update the catch to be empty (or optionally add a brief comment) and leave the symbols docsVersions and require('./versions.json') as the markers to locate the change.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/docusaurus.config.js`:
- Around line 8-13: The variable docsVersions is pre-initialized to [] and the
catch block redundantly reassigns docsVersions = []; remove the redundant
assignment inside the catch so the try/catch simply attempts to set docsVersions
= require('./versions.json') and silently falls back to the pre-initialized
value if require throws; update the catch to be empty (or optionally add a brief
comment) and leave the symbols docsVersions and require('./versions.json') as
the markers to locate the change.
chhoumann
deleted the
1109-automate-docs-version-snapshot-+-lastversion-update-on-each-release
branch
github-actions Bot
pushed a commit
that referenced
this pull request
Mar 5, 2026
# [2.12.0](2.11.0...2.12.0) (2026-03-05) ### Bug Fixes * **capture:** preserve canvas tab indentation on configured writes ([#1125](#1125)) ([0a1578e](0a1578e)) * disallow capture targets with .base extension ([cb39ed4](cb39ed4)) * **field-suggestions:** opt-in inline values from fenced code blocks ([#1128](#1128)) ([8597905](8597905)) * **gui:** preserve modal edit position during settings reload ([#1132](#1132)) ([11bda19](11bda19)) * **gui:** reduce ai settings modal reload churn ([#1134](#1134)) ([ae0f7a1](ae0f7a1)) * **gui:** reduce choice builder reload churn ([#1136](#1136)) ([818272a](818272a)) * **gui:** reduce macro settings modal reload churn ([#1135](#1135)) ([a1a6271](a1a6271)) * harden existing-tab matching and document issue workflow ([#1108](#1108)) ([7b12d3b](7b12d3b)) * make template path resolution deterministic ([3297d54](3297d54)) * normalize capture title for non-markdown targets ([964d672](964d672)) * preserve capture-format spacing for insert-at-end ([#1119](#1119)) ([8bb8ed4](8bb8ed4)) * preserve explicit capture target file extensions ([57e43ff](57e43ff)) * preserve insert-at-end order for non-newline captures ([#1120](#1120)) ([e7cbbf2](e7cbbf2)) * resolve template file-name paths without duplicate default folder ([7bfd41b](7bfd41b)) * resolve vault-relative template paths using root folders ([81216de](81216de)) ### Features * add AI request logging API and reduce assistant log noise ([#1110](#1110)) ([2c36800](2c36800)) * automate docs version snapshot during release ([#1111](#1111)) ([1571846](1571846)) * **capture:** fully support capture into canvas cards ([#1124](#1124)) ([a53f889](a53f889)) * **cli:** add native QuickAdd Obsidian CLI handlers ([#1129](#1129)) ([8102d47](8102d47)) * **format:** support mapped VALUE suggester display text ([#1127](#1127)) ([b8ec56c](b8ec56c)) * **macro:** add editor cursor navigation commands ([101d5f6](101d5f6)) * support .base template files for template choices ([11e6490](11e6490)) ### Reverts * **gui:** remove modal reload refactor series ([#1137](#1137)) ([3ba1a73](3ba1a73)), closes [#1136](#1136) [#1135](#1135) [#1134](#1134) [#1133](#1133) [#1132](#1132)
|
🎉 This PR is included in version 2.12.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
lastVersiondynamically fromdocs/versions.jsonCloses #1109
Summary by CodeRabbit
New Features
Chores